home *** CD-ROM | disk | FTP | other *** search
/ Best Tools for JAVA / Best Tools for JAVA.iso / DATABASE / IDBA / DATA.1 / README.TXT < prev   
Encoding:
Text File  |  1996-07-18  |  11.5 KB  |  326 lines
  1. ______________________________________________________________________________
  2.  
  3. Intranet Database Assistant (IDBA) README FILE
  4. IDBA Version 1.1.
  5. (C) Copyright 1996. Intranet 2001, Inc.
  6. All rights reserved.
  7. ______________________________________________________________________________
  8.  
  9. Thank you for your interest in the Intranet Database Assistant. 
  10. This file includes information on features, known problems, and
  11. how to contact Intranet 2001.
  12.  
  13. Contents
  14. --------
  15.  
  16. 1. Introducing The Intranet Database Assistant.
  17. 2. Getting Started with the Sample HTML Files.
  18. 3. Basic Intranet Database Assistant Syntax for HTML.
  19. 4. KNOWN PROBLEMS.
  20. 5. Customer Feedback.
  21.  
  22.  
  23.  
  24. 1. Introducing The Intranet Database Assistant
  25. ----------------------------------------------
  26.  
  27. The Intranet Database Assistant allows direct SQL connectivity between your 
  28. HTML files and multiple ODBC (or direct*) data sources, with minimal overhead. 
  29. IDBA is lightweight making it scalable. 
  30.  
  31. IDBA will fit in comfortably with an environment that scales from a personal 
  32. peer computer that needs to display basic database information, through to a 
  33. large corporate entity that has complex SQL queries.
  34.  
  35. Here are some the Intranet Database Assistant's powerful features:
  36.  
  37. 1. It Generates HTML objects dynamically (like Tables and Lists) directly 
  38.    from your databases, with minimal HTML maintenance. (No CGI involved !)
  39.  
  40. 2. It allows multiple SQL queries within the same HTML page.
  41.  
  42. 3. It allows HTML forms to store data directly to your databases.
  43.  
  44. 4. It allows you to use the Web internally/externally to display HTML
  45.    content directly from your databases.
  46.  
  47. 5. It has Fax and Email capabilities that tie in with MS-Exchange.
  48.  
  49. 6. Uses simple notation (no programming) to produce powerful results.
  50.  
  51.  
  52. 2. Getting Started with the Sample HTML files
  53. --------------------------------------------- 
  54.  
  55.  
  56. 1. Please ensure that you have ODBC32, MS-Access and NorthWind.mdb 
  57. installed on your system. [See IDBA requirements]
  58.  
  59. 2. Run the executable IDBA.EXE found in the \Program Files\Intranet 2001\idba\program 
  60. folder. This can be done by clicking on the "Start" button found on the Win95 taskbar, 
  61. then selecting the following menus;
  62.     
  63.     ----------------
  64.     | Programs  -> |--------------------
  65.     ----------------  Intranet 2001 -> |------------------------------
  66.                        --------------------- Intranet Database Assistant |
  67.                                             ------------------------------
  68.  
  69. If IDBA appears in your Win95 ICONTRAY then RightMouseButton click on the icon, 
  70. select "Open" or "Configuration" in the menu, and either the application or the 
  71. configuration dialog will appear.
  72.  
  73. 3. If you have already have a web server running on your PC, then its port number 
  74. address might confict with the IDBA's port address. If this is the case, then change 
  75. IDBA's port number to another value (e.g. 40) by selecting the following menus on IDBA;
  76.     
  77.     -----------
  78.     | View -> |----------------     ----------
  79.     ----------- Configuration | AND | Server | TAB
  80.            ----------------     ----------
  81.                                     
  82.  
  83. and change "Listen on HTTP Port:" default (80)  to 40 (or any other reasonable value).
  84. Select "OK" when done.
  85.  
  86. 4. To try the samples, you specify a "Data Source Name" for the NorthWind.mdb sample 
  87. that comes with MS-Access. This can be done by clicking on the "Start" button found on 
  88. the Win95 taskbar, then selecting the following menus;
  89.  
  90.     ----------------
  91.     | Settings  -> |------------------
  92.     ----------------  Control Panel  |
  93.                        -------------------
  94.  
  95. * Double click on the "ODBC32" icon. 
  96. * Click on the "Add" button.
  97. * In the "Add Data Source" dialog, select the Microsoft Access driver (*.mdb) in the 
  98. ODBC drivers list box. Then click on "OK".
  99. * In the ODBC MS-Access setup dialog box, Enter "NorthWind" in the DataSourceName 
  100. edit box, and select "Northwind.mdb" using the Database->"Select" button. Click on 
  101. "OK" and then click on "Close" on the  DataSources dialog.
  102.  
  103. Next, select 
  104.  
  105.     -----------
  106.     | View -> |----------------      ---------------
  107.     ----------- Configuration |  AND | DataSources | TAB
  108.            ----------------      --------------- 
  109.                                      
  110.  
  111.  
  112. Select "NorthWind" in the ODBC Sources list, and then click on the "Add" button. 
  113. This should add the NorthWind datasourcename to the IDBA sources list. 
  114. Click on "OK". 
  115.  
  116. 5. Run your Internet browser and load "QueryForm.htm" by entering "http://127.0.0.1/" 
  117. in the www address/location text entry field.
  118.  
  119.     [Note:    if you change IDBA's port number,  the string becomes;
  120.         http://127.0.0.1:40/
  121.     where 40 specifies the port number (as in step 3 above)]
  122.  
  123. At this point you should be able to submit queries, and modify the HTML files to see 
  124. what IDBA can do.
  125.  
  126. 6. If you want to set up a default directory to store your own HTML files, where 
  127. anyone in your intranet environment can access these files using your machine name. 
  128. Then select the following menus on IDBA;
  129.  
  130.     -----------
  131.     | View -> |----------------     --------------
  132.     ----------- Configuration | AND | HTML Files | TAB
  133.                   -----------------     --------------
  134.                                     
  135.     
  136. And change the default directory and index file to point to your own default directory 
  137. using the "Browse" button.
  138.   
  139. [Warning: If you change the default directory, the sample HTML files will not run, 
  140. unless an absolute path to them is specified in your browser.]
  141.  
  142.  
  143.  
  144. 3. Basic Intranet Database Assistant Syntax for HTML:
  145. -----------------------------------------------------
  146.  
  147. All IDBA Syntax appear as comment tags within HTML pages, so that invalid
  148. database access does not cause URL failures or bad appearances of Information.
  149.  
  150. An IDBA Query statement in HTML simply looks like this:
  151.  
  152.  <!Query::DSN=DataSourceName::SQL=SQL statement::TYPE=Output Format::END>
  153.  
  154. Output Formats supported  are:
  155. ------------------------------
  156.  
  157. 1. TYPE=TABLE   - Generates a HTML <TABLE> object filled with data from your query. 
  158. 2. TYPE=ULIST   - Generates a HTML <UL> object filled with data from your query.
  159. 3. TYPE=OLIST   - Generates a HTML <OL> object filled with data from your query.
  160. 4. TYPE=MENU    - Generates a HTML <MENU> object filled with data from your query.
  161. 5. TYPE=SELECT  - Generates a HTML <SELECT> object filled with data from your query.
  162. 6. TYPE=MSELECT - Generates a HTML <SELECT MULTIPLE> object filled with data from your query.
  163. 6. TYPE=SPREAD  - Holds your query results in memory, for future access.
  164. 7. TYPE=MODIFY  - Inserts/Updates or Deletes data in your database.
  165.  
  166. !!! Please consult IDBA's help file for more details on IDBA objects and syntax !!!
  167.  
  168. More Output formats are supported in the Enterprise Edition.
  169.  
  170. Other IDBA-Specifiers
  171. =====================
  172.  
  173. Error Reporting:
  174. ----------------
  175.  
  176. 1. OK=XXX::     Outputs the user specified message "XXX" in HTML format
  177.                 on success of a database query.
  178.  
  179. 2. FAIL=XXX::    Outputs the user specified message "XXX" in HTML format
  180.         on failure of a database query.
  181.  
  182. JUMP(vRelPathAndName) allows a jump to another HTML file, using the vRelPathAndName of that file.
  183.  
  184. e.g. FAIL=JUMP(c:\HTML\error.html):: will display error.html if an error in the query occurs
  185.  
  186. Accessing data in memory:
  187. -------------------------
  188.  
  189. 1. <!DATA(row,col)> allows you to access data as a result of a query which uses the type SPREAD.
  190.  
  191. row - zero based index into result table (zero will give column headers).
  192. col - one based index into result table (zero is an illegal value).
  193.  
  194. e.g. <!DATA(0,1)> will access the header for column one and display it in HTML text.
  195.  
  196. Substituting Form variables
  197. ---------------------------
  198.  
  199. 1. VAR(vName) will substitute the variable name vName with its value, and display it in HTML. 
  200. Where vName=value is received through a POST or GET.
  201.  
  202. 2. VARQ(vName) does the same as 1. In addition, it adds quotes to the substituted value for queries.
  203. e.g.: VARQ(vName) where vName=Fred will result in 'Fred'.
  204.  
  205.  
  206. Examples:
  207. =========
  208.  
  209. (a) To output everything from a "Customers" database table as a HTML table;
  210.  
  211. <!Query::DSN=NorthWind::SQL=Select * From Customers::TYPE=TABLE::END>
  212.  
  213. (b) To output the customer name column from a "Customers" database table as a HTML list;
  214.  
  215. <!Query::DSN=NorthWind::SQL=Select CustomerName From Customers::TYPE=ULIST::END>
  216.  
  217. (c) To insert data into an "Employees" database table;
  218.  
  219.     <!Query::DSN=NorthWind
  220.            ::SQL=Insert into Employees 
  221.             EmployeeID, lastname, firstname 
  222.              values 
  223.             (25,ÆJohnÆ,ÆDoeÆ)
  224.            ::TYPE=MODIFY::
  225.     END>
  226.  
  227. The above query is not very useful without variables. 
  228.  
  229. (d) To execute a Stored Procedure (only where supported by the database);
  230.  
  231.     <!Query::DSN=NorthWind
  232.            ::SQL=execute AddEmployee (25,ÆJohnÆ,ÆDoeÆ)
  233.            ::TYPE=MODIFY::
  234.     END>
  235.  
  236.  
  237. Forms And Variables
  238. -------------------
  239.  
  240. As seen in the above examples, a query (especially where user interaction is involved)
  241. is not very useful without the use of variables. This is where the HTML form
  242. and the IDBA-VAR tag combine to make a powerful combination.
  243.  
  244.     Form.htm                      Action.htm
  245.     |--------------------------|             |----------------|
  246.     |                | GET/PUT emp_id=2     |          |
  247.     | Enter EmployeeID: [ 2 ]  |-------------------->| <!Query::...      |
  248.     |               |             | VAR(emp_id)    |    
  249.     | [Submit][Reset]       |             |  ...::END>     |
  250.     |               |             |          |
  251.     |--------------------------|             |----------------|
  252.  
  253.  
  254. In the above diagram, a user inputs the variable 2 and selects "Submit". This
  255. variable is passed through to the action.htm URL which contains an IDBA-Query.
  256. The query is then executed using the variable 2.
  257.  
  258. IDBA-Variable specifiers are of the form:
  259.  
  260.     VAR(VARIABLE_IDENTIFIER)
  261.     VARQ(VARIABLE_IDENTIFIER)
  262.  
  263. where VARIABLE_IDENTIFIER is the name of the control on the form page.
  264.     
  265. A Form-Action URL Example using variables:
  266. ------------------------------------------
  267.  
  268. Form HTML Page:
  269.  
  270.     <form METHOD=GET action = "SalesCategoryResult.htm" >
  271.     <p><select name="CategoryNameX" size=1>
  272.     <option selected>Beverages</option>
  273.     <option>Condiments</option>
  274.     <option>Confections</option>
  275.     <option>Dairy Products</option>
  276.     <option>Grains/Cereals</option>
  277.     <option>Meat/Poultry</option>
  278.     <option>Produce</option>
  279.     <option>Seafood</option>
  280.     </select></p>
  281.  
  282.     <p><input type=submit> <input type=reset></p>
  283.  
  284.     </form>
  285.  
  286. Result Query HTML Page:
  287.  
  288.     <!QUERY::DSN=NorthWind
  289.         ::SQL=SELECT * From [Sales by Category] 
  290.             WHERE CategoryName = VARQ(CategoryNameX)
  291.         ::TYPE=TABLE::END>
  292.  
  293.  
  294. 4. KNOWN PROBLEMS
  295. -----------------
  296.  
  297. The problems stated below are known and are being addressed for the release
  298. version of IDBA.
  299.  
  300. 1) Queries which generate very large tables do not get displayed at the client end, although the query may succeed.
  301.  
  302. 2) Certain ODBC drivers may cause problems.
  303.  
  304. 5. Customer Feedback
  305. --------------------
  306.  
  307. Your feedback, or comments concerning any aspect of this product is welcome.
  308. If you have any questions, problems or concerns, please contact us using the 
  309. Information below.
  310.  
  311. How to contact INTRANET 2001, Inc.
  312. ----------------------------------
  313.  
  314. Please contact us for more information at 
  315.  
  316. http://www.inet2001.com or
  317. Email : info@inet2001.com 
  318.     sales@inet2001.com
  319.  
  320.     
  321. ------------------------------------------------------------------------------
  322. Intranet Database Assistant is a trademark of Intranet 2001, Inc. All other
  323. product and company names are trademarks or registered trademarks of their
  324. respective companies.
  325. ------------------------------------------------------------------------------
  326.